home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 2000 August: Tool Chest / Dev.CD Aug 00 TC Disk 2.toast / pc / sample code / networking / pgpuam / sources / pgpuamclient.c < prev    next >
Encoding:
Text File  |  2000-06-23  |  16.2 KB  |  576 lines
  1. /*
  2.     File:            PGPUAMclient.c
  3.  
  4.     Description:     PGP Appleshare User Authentication Module
  5.  
  6.     Written by:    Vinnie Moscaritolo
  7.  
  8.     Copyright:    © 1998 by Apple Computer, Inc., all rights reserved.
  9.  
  10.     Change History (most recent first):
  11.  
  12.     You may incorporate this sample code into your applications without
  13.     restriction, though the sample code has been provided "AS IS" and the
  14.     responsibility for its operation is 100% yours.  However, what you are
  15.     not permitted to do is to redistribute the source as "DSC Sample Code"
  16.     after having made changes. If you're going to re-distribute the source,
  17.     we require that you make it clear in the source that the code was
  18.     descended from Apple Sample Code, but that you've made changes.
  19. */
  20.  
  21. //------------------------------------------------------------------------------------
  22. #pragma mark Includes
  23. //------------------------------------------------------------------------------------
  24. #include <Errors.h>
  25. #include <String.h>
  26. #include <A4Stuff.h>
  27. #include <Resources.h>
  28. #include <MixedMode.h>
  29. #include <Appearance.h>
  30. #include <CodeFragments.h>
  31. #include <Gestalt.h>
  32. #include <PLStringFuncs.h>
  33.  
  34. #include "ClientUAM.h" 
  35. #include "AFPPackets.h"
  36.  
  37. #include <stdio.h>
  38.  
  39. #include "TPGPkey.h"
  40. #include "TPGPException.h"
  41. #include "TMacException.h"
  42. #include "TASIPPGPkey.h"
  43. #include "ASIPChallenge.h"
  44. #include "PGPUAMdefines.h"
  45. #include "PGPUAMclient.h"
  46. #include "PGPUAMclientLoginDialog.h"
  47. #include "PGPUAMclientProtocol.h"
  48. #include "PGPUAMmsgFormat.h"
  49. #include "PGPUAMclient.h"
  50. #include "TPGPUAMPrefs.h"
  51. #include "pgpUserInterface.h"
  52.  
  53.  
  54.  
  55. // ---------------------------------------------------------------------------
  56. #pragma mark Exported Symbols
  57. // ---------------------------------------------------------------------------
  58.  
  59. #ifdef __cplusplus
  60. extern "C" {
  61. #endif
  62. #pragma export on
  63.     extern  const long __procinfo = kUAMCallProcInfo;
  64.             OSErr        __pgpuam_initialize(CFragInitBlockPtr ibp);
  65.             void        __pgpuam_terminate(void);
  66.     pascal     OSStatus     __pgpuam_client (UAMArgs *theArgs);
  67.  
  68.     pascal OSErr __initialize(const CFragInitBlock *theInitBlock);
  69.     pascal OSErr __terminate(void);
  70.     #pragma export off
  71.  
  72.  
  73. #ifdef __cplusplus
  74. }
  75. #endif
  76.  
  77.  
  78. // ---------------------------------------------------------------------------
  79. #pragma mark Globals
  80. // ---------------------------------------------------------------------------
  81.     AFPSrvrInfo *    gAFPServerInfo    = nil;
  82.     AFPClientInfo *    gClientInfo     = nil;
  83.     UInt8 *            gAFPSrvrSig     = nil;
  84.  
  85. // ---------------------------------------------------------------------------
  86. #pragma mark Local Prototypes
  87. // ---------------------------------------------------------------------------
  88.  
  89. static    OSStatus    PGPUAMOpen    (UAMArgs *theArgs);
  90. static    OSStatus    PGPUAMClose (UAMArgs *theArgs);
  91. static    OSStatus    PGPUAMLogin (UAMArgs *theArgs);
  92.  
  93.  
  94. static     OSStatus     InitiateConnection (StringPtr userName, 
  95.                                         StringPtr serverName,
  96.                                         short *sessionRefNum, 
  97.                                         TPGPUAMPrefs *userPrefs, 
  98.                                         TASIPPGPkey *serverKey, 
  99.                                         IdleConnectionProcPtr idleProc, 
  100.                                         void* context );
  101.                                         
  102. static     void         TerminateConnection (void* context);
  103.  
  104. static StringPtr     FigureAFPVersion(    AFPSrvrInfo *info,ClientUAMCallbackRec *callbacks);
  105. static Boolean         FindStringInBuf(    StringPtr string, Ptr buf, UInt32 bufSize);
  106.  
  107. static void         PostError(short errorStrId, short explanStrID);
  108.  
  109. // test code..
  110.  
  111. // ---------------------------------------------------------------------------
  112. OSErr __pgpuam_initialize(CFragInitBlockPtr ibp)
  113. // ---------------------------------------------------------------------------
  114. //
  115. //  PGPUAM Library Initialization
  116. //
  117.  
  118. {
  119.       long    gestaltResult;
  120.     OSErr    err = -1;
  121.     
  122.     /*
  123.     ** Check for a 68020 or later processor and bail immediately if
  124.     ** none is available.
  125.     */
  126. //DebugStr("\p__pgpuam_initialize");
  127.  
  128.     if( Gestalt( gestaltProcessorType, &gestaltResult ) == noErr &&
  129.         gestaltResult >= gestalt68020 )
  130.         {
  131.             err = __initialize( ibp );
  132.          }
  133.  
  134.      return err;
  135. }
  136.  
  137.  
  138. // ---------------------------------------------------------------------------
  139. void __pgpuam_terminate(void)
  140. // ---------------------------------------------------------------------------
  141. //
  142. //  PGPUAM Library Termination
  143. //
  144.  
  145. {
  146.     __terminate();
  147. }
  148.  
  149.  
  150. #pragma mark -
  151. // ---------------------------------------------------------------------------
  152. pascal OSStatus __pgpuam_client(UAMArgs *theArgs)
  153. // ---------------------------------------------------------------------------
  154. {
  155.      OSStatus    error;
  156.     char         errorBuf[256];
  157.     char         explanationBuf[256];
  158. //    ostrstream err( errorBuf,256);
  159. //    ostrstream explain( explanationBuf,256);
  160.  
  161.       EnterCodeResource();
  162.     try
  163.     {
  164.          switch(theArgs->command)
  165.         {
  166.             case    kUAMOpen:
  167.     //            DebugStr("\pUAMCall - kUAMOpen");
  168.                 error =    PGPUAMOpen(theArgs);
  169.                 break;
  170.                                     
  171.             case    kUAMPWDlog:
  172.     //            DebugStr("\pUAMCall - kUAMPWDlog");
  173.                 error =    noErr;
  174.                 break;
  175.  
  176.             case    kUAMLogin:
  177.     //            DebugStr("\pUAMCall - kUAMLogin");
  178.                  error =    PGPUAMLogin(theArgs);
  179.                 break;
  180.             
  181.             case    kUAMVSDlog:
  182.     //            DebugStr("\pUAMCall - kUAMVSDlog");
  183.                 error =    noErr;
  184.                 break;
  185.  
  186.             case    kUAMChgPassDlg:
  187.                 DebugStr("\pUAMCall - kUAMChgPassDlg");
  188.                 error =    kNotForUs;
  189.                 break;
  190.  
  191.             case    kUAMChgPass:
  192.                 DebugStr("\pUAMCall - kUAMChgPass");
  193.                 error =    kNotForUs;
  194.                 break;
  195.  
  196.             case    kUAMGetInfoSize:
  197.                 DebugStr("\pUAMCall - kUAMGetInfoSize");
  198.     //            uamInfoSize = n;
  199.                 error =    kNotForUs;
  200.                 break;
  201.  
  202.             case    kUAMGetInfo:
  203.                 DebugStr("\pUAMCall - kUAMGetInfo");
  204.     //            uamInfo < == 
  205.                 error =    kNotForUs;
  206.                 break;
  207.  
  208.             case    kUAMClose:
  209.     //            DebugStr("\pUAMCall - kUAMClose");
  210.                 error =    PGPUAMClose(theArgs);
  211.                 break;
  212.  
  213.             default:
  214.                 DebugStr("\psome other UAMCall");
  215.                 error =    kNotForUs;
  216.                 break;
  217.         }
  218.     }
  219.     catch (TMacException &ex)
  220.     {
  221.         SInt16             itemHit;
  222.     
  223.         error = theArgs->result = ex.GetExceptionErr(); 
  224.          if(error == noErr) 
  225.                  error = userCanceledErr;
  226.  
  227.         errorBuf[0] = sprintf(&errorBuf[1], "%s\rPGPUAM Error: %d\rFile: %s, Line: %d",  
  228.                              ex.GetExceptionMessage(),  ex.GetExceptionErr(), ex.GetExceptionFile(), ex.GetExceptionLine());
  229.                              
  230.         StandardAlert(kAlertStopAlert,"\pThe PGP Challenge/Response UAM could not be used.", 
  231.                                         (UInt8 *) errorBuf, nil , &itemHit);
  232.     }
  233.  
  234. // handle PGP errors
  235.     catch (TPGPException &ex)
  236.     {
  237.         SInt16             itemHit;
  238.          PGPGetErrorString ( ex.GetExceptionErr(), sizeof(explanationBuf), explanationBuf);
  239.         
  240.         errorBuf[0] = sprintf(&errorBuf[1], "%s\r\rPGPUAM Error: %d\rFile: %s, Line: %d",  
  241.                             ex.GetExceptionMessage(),  ex.GetExceptionErr(),  ex.GetExceptionFile(),  ex.GetExceptionLine());
  242.     
  243.         c2pstr(explanationBuf);
  244.          StandardAlert(kAlertStopAlert,(UInt8 *)errorBuf, (UInt8 *)explanationBuf, nil , &itemHit);
  245.         error = theArgs->result = userCanceledErr; 
  246.     }
  247.  
  248.      ExitCodeResource();
  249.     return error;
  250. } 
  251.  
  252. // ---------------------------------------------------------------------------
  253. static OSStatus    PGPUAMOpen(UAMArgs *theArgs)
  254. // ---------------------------------------------------------------------------
  255.  {
  256.       OSStatus    ErrNo ;    
  257.      long        response = 0;
  258.  
  259. // Get the AppleShare Client info
  260.     ErrNo = CallUniversalProc( theArgs->callbacks->GetClientInfoUPP, kGetClientInfoProcInfo,  kAFPClientInfo, &gClientInfo);
  261.     if(ErrNo != noErr) return ErrNo;
  262.     
  263. // check agaisnt client versions
  264.     ThrowMsgIfNot ( (gClientInfo->fVersion > 8), 
  265.         "This UAM requires AppleShare Client 3.8.1 or later");
  266.     
  267. // Save the server info pointer.
  268.       gAFPServerInfo  = theArgs->Opt.open.srvrInfo;
  269.       
  270. // calculate server signature block.
  271.         UInt8             *signatureOffset;
  272.         signatureOffset =  (&gAFPServerInfo->fSrvrName[0] + gAFPServerInfo->fSrvrName[0] + 1);
  273.         if ( (UInt32)signatureOffset & 0x01) signatureOffset++;
  274.          gAFPSrvrSig = ((UInt8*) gAFPServerInfo)  + * ((short*)signatureOffset);
  275.  
  276. // Is  Appearance Mgr available ?
  277.      ThrowMsgIfNot ( ((Gestalt(gestaltAppearanceAttr, &response) == noErr) 
  278.                     && ((long)RegisterAppearanceClient != kUnresolvedCFragSymbolAddress)) ,
  279.          "Appearance Mgr is required");     
  280.  
  281.  // collection manager too
  282.     ThrowMsgIfNot ( ((Gestalt(gestaltCollectionMgrVersion, &response) == noErr) 
  283.                     && ((long)NewCollection != kUnresolvedCFragSymbolAddress)) ,
  284.          "Collection Mgr is required");     
  285.  
  286. // Is  PGPsdk available ?
  287.      ThrowMsgIfNot ((long)PGPNewContext != kUnresolvedCFragSymbolAddress,
  288.          "PGPsdk is required");     
  289.  
  290. // Is  PGPsdkUIlib available ?
  291.      ThrowMsgIfNot ((long)PGPSigningPassphraseDialog != kUnresolvedCFragSymbolAddress ,
  292.          "PGPsdkUIlib is required");     
  293.  
  294. // Create a new PGP context
  295.     TPGPkey::Initialize();
  296.  
  297. // establish link to PassphraseCache
  298. //???
  299.  
  300.      theArgs->result = ((1 << kUsePWDlog) | (1 << kUseUAMInfo)) ;
  301.     return noErr;
  302. }
  303.  
  304. // ---------------------------------------------------------------------------
  305. static OSStatus    PGPUAMLogin(UAMArgs *theArgs)
  306. // ---------------------------------------------------------------------------
  307. {
  308.     TPGPUAMPrefs*    userPrefs    = nil;
  309.     Str63            userName;
  310.  
  311. // Get user prefs     
  312.     userPrefs = new  TPGPUAMPrefs();
  313.     userPrefs->Initialize();
  314.  
  315. // open the keyring    
  316.     TPGPkey::OpenKeyDefaultRing();
  317.  
  318. // if no username was specified.. (Alias resolution)
  319. // Initiate the connection w/o UI
  320.     if(theArgs->Opt.auth.userName[0] != '\0')
  321.     {
  322.         TASIPPGPkey        theServerKey;
  323.         
  324.     // copy the user name from the authblock
  325.         PLstrcpy( userName, theArgs->Opt.auth.userName);
  326.     
  327.     
  328.     // pickup the server key
  329.         theServerKey.Initialize(gAFPSrvrSig);
  330.         
  331.     // initiate connection directly
  332.         theArgs->result = InitiateConnection(userName, gAFPServerInfo->fSrvrName, &theArgs->sessionRefNum, userPrefs, &theServerKey, nil, theArgs);
  333.     
  334.      } 
  335.     else 
  336.     {
  337.      // copy the default user name.
  338.         PLstrcpy( userName, gClientInfo->fDefaultUserName);
  339.  
  340.      // initiate connection with User Interface
  341.         theArgs->result = DoLoginDialog( userName, 
  342.                                          gAFPServerInfo->fSrvrName,
  343.                                          &theArgs->sessionRefNum,
  344.                                          userPrefs,
  345.                                          InitiateConnection,
  346.                                          TerminateConnection,
  347.                                          theArgs->callbacks->EventCallbackUPP,
  348.                                          theArgs);
  349.  
  350.     // put username into the authblock buffer for later Alias resolution
  351.         PLstrcpy(theArgs->Opt.auth.userName, userName);
  352.         
  353.     // not clear if I should post the error or not
  354.     // you might want to take out the next line...
  355.         if(( theArgs->result != noErr) && (theArgs->result != userCanceledErr))
  356.              PostError( kErrOther, kErrOtherExplanation);
  357.     }
  358.  
  359. // close the keyring
  360.     TPGPkey::CloseKeyRing();
  361.  
  362. // update user prefs
  363.     userPrefs->Finalize();
  364.     delete userPrefs;
  365.         
  366.       return (theArgs->result) ;
  367. }
  368.  
  369. // ---------------------------------------------------------------------------
  370. static OSStatus    PGPUAMClose(UAMArgs *theArgs)
  371. // ---------------------------------------------------------------------------
  372.  {
  373.  
  374. // remove PGP context        
  375.         TPGPkey::Finalize();
  376.         
  377.     return noErr;
  378. }
  379.  
  380. #pragma mark -
  381.  
  382.  
  383. // ---------------------------------------------------------------------------
  384. static OSStatus InitiateConnection( StringPtr    userName,
  385.                                         StringPtr    serverName, 
  386.                                      short       *sessionRefNum,
  387.                                      TPGPUAMPrefs *userPrefs,
  388.                                      TASIPPGPkey    *serverKey,
  389.                         IdleConnectionProcPtr    idleProc,
  390.                                      void*        context)
  391. // ---------------------------------------------------------------------------
  392. {
  393.     UAMArgs         *theArgs = (UAMArgs *) context;
  394.     PUAM_LOGIN_RESP    resp;
  395.     StringPtr        serverVersion;
  396.     Str63             challengeString;
  397.     Str63             answerString;
  398.     Str255            promptString;
  399.  
  400.     UInt8            replyBuffer[256];
  401.     UInt32              replyBufferSize;
  402.     Handle            uamName;
  403.       OSStatus        ErrNo ;        
  404.   
  405.     // calculate which AFPversion we will use.
  406.     serverVersion = FigureAFPVersion(gAFPServerInfo,theArgs->callbacks);
  407.      if(!serverVersion){
  408.         // put up an alert & return userCancelled error
  409.         DebugStr("\pno AFP version returned by server");
  410.         return userCanceledErr;
  411.     }
  412.  
  413.     // get the UAMSTring from the resource
  414.     uamName = Get1Resource(kUAMStr,kUAMProtoName);
  415.     ThrowMacErrIfNil(uamName, ResError());
  416.     
  417.     // Calculate Challenge String    
  418.     MakeChallenge(serverKey, challengeString);
  419.     
  420.     // send OpenSession command to server.
  421.     HLock(uamName);
  422.     ErrNo = SndLoginCmd(    theArgs->callbacks,
  423.                             serverVersion, (StringPtr) *uamName,  userName, 
  424.                             challengeString,
  425.                             theArgs->Opt.auth.srvrAddress, 
  426.                             replyBuffer,   sizeof (replyBuffer),  &replyBufferSize,                 
  427.                             sessionRefNum,
  428.                             idleProc);     
  429.     HUnlock(uamName);
  430.      if( ErrNo != kFPAuthContinue )    return ErrNo;
  431.      ErrNo = userCanceledErr;
  432.      
  433.     // parse the reply
  434.      ParseLoginResp(replyBuffer,  &replyBufferSize, &resp);
  435.  
  436.     // check the reply
  437.     if( !  VerifyChallenge(serverKey, challengeString, resp.CounterChallengePString))
  438.     {
  439.  
  440. // warn user that server didnt check out!
  441.         Str255         errorBuf, explainBuf;
  442.         SInt16         itemHit;
  443.         AlertStdAlertParamRec aRec;
  444.         
  445.         aRec.movable     = true;
  446.         aRec.helpButton    = false;
  447.         aRec.filterProc = nil;
  448.         aRec.defaultText =  userPrefs->GetAuthenticateServer()? (unsigned char*) -1 : "\pAbort";
  449.          aRec.cancelText     =  userPrefs->GetAuthenticateServer()? nil:"\pContinue";
  450.          aRec.otherText     = nil;
  451.         aRec.defaultButton = kAlertStdAlertOKButton;
  452.         aRec.cancelButton  = kAlertStdAlertCancelButton;
  453.         aRec.position  = kWindowAlertPositionParentWindowScreen;
  454.             
  455.         GetIndString(errorBuf, kErrorStringsID, kErrUnableToAuthErr);
  456.         PLstrcat(errorBuf, "\p\"");
  457.         PLstrcat(errorBuf, serverName);
  458.         PLstrcat(errorBuf, "\p\".");
  459.         GetIndString(explainBuf, kErrorStringsID,  userPrefs->GetAuthenticateServer() ? kErrUnableToAuthExplanation: kErrUnableToAuthContinueExplanation);
  460.         
  461.          StandardAlert(kAlertCautionAlert, errorBuf, explainBuf, &aRec , &itemHit);
  462.            
  463.          if(itemHit == kAlertStdAlertOKButton) return userCanceledErr;
  464.      };
  465.  
  466.     // build custom prompt string
  467.     PLstrcpy(promptString, "\pTo connect to \"");
  468.      PLstrcat(promptString, serverName);
  469.      PLstrcat(promptString, "\p\", please enter the passphrase for the following key.");
  470.     p2cstr(promptString);
  471.     
  472.      ErrNo = ReplyToCounterChallenge(promptString, resp.FingerPrintPString, resp.CounterChallengePString, answerString);
  473.     if(ErrNo == userCanceledErr) return ErrNo;
  474.     
  475.     if(ErrNo != noErr)
  476.     {
  477.         PostError(kErrClientUnableToAuthErr, kErrClientUnableToAuthExplanation);
  478.          return userCanceledErr;
  479.     }
  480.     
  481.      ErrNo = SndLoginContinueCmd(theArgs->callbacks, *sessionRefNum, answerString,
  482.                                     replyBuffer,   sizeof (replyBuffer),  &replyBufferSize, idleProc);    
  483.      
  484.     return ErrNo;
  485. }
  486.  
  487.  
  488.  
  489. // ---------------------------------------------------------------------------
  490. static void PostError(short errorStrId,short explanStrID)
  491. // ---------------------------------------------------------------------------
  492. //
  493. {
  494.           Str255         errorBuf, explainBuf;
  495.         SInt16         itemHit;
  496.  
  497.         GetIndString(errorBuf, kErrorStringsID, errorStrId);
  498.  
  499.         if(explanStrID) 
  500.             GetIndString(explainBuf, kErrorStringsID, explanStrID);
  501.  
  502.         StandardAlert(kAlertStopAlert,errorBuf, (explanStrID)?explainBuf:nil, nil , &itemHit);
  503. }
  504.  
  505. // ---------------------------------------------------------------------------
  506. static void TerminateConnection(void* context)
  507. // ---------------------------------------------------------------------------
  508. {
  509.     UAMArgs *theArgs = (UAMArgs *) context;
  510.      
  511. }
  512.  
  513. #pragma mark -
  514.   
  515. // ---------------------------------------------------------------------------
  516. static StringPtr    FigureAFPVersion(AFPSrvrInfo *info,ClientUAMCallbackRec *callbacks)
  517. // ---------------------------------------------------------------------------
  518. {
  519.     struct    AFPClientInfo *theClientInfo = nil;
  520.     short    index;
  521.     Ptr        versBuf;
  522.     UInt32    versBufsize;
  523.  
  524. #if 0
  525. // Hack
  526.     return "\pAFP TEST VERSION";
  527. // Hack
  528. #endif
  529.     
  530. //DebugStr("\pFigureAFPVersion");
  531.  
  532.     CallUniversalProc( callbacks->GetClientInfoUPP, kGetClientInfoProcInfo,  kAFPClientInfo, &theClientInfo);
  533.  
  534.     if(theClientInfo){                
  535.     // go through the list of AFP versions supported and try to find them
  536.     // in the SrvrInfoBuffer, first match gets it 
  537.         versBuf = (Ptr)((UInt32)info + info->fVerCountOffset+1);
  538.         versBufsize = kMaxAFPCommand - info->fVerCountOffset;    // the largest size
  539.         
  540.         for(index = 0; index < theClientInfo->fNumAFPVersions; index++){
  541.             if(FindStringInBuf(theClientInfo->fAFPVersionStrs[index],versBuf,versBufsize)){
  542.                 return theClientInfo->fAFPVersionStrs[index];
  543.             }
  544.         }
  545.     }
  546.     return    nil;
  547. }
  548.  
  549. // ---------------------------------------------------------------------------
  550. static Boolean FindStringInBuf(StringPtr string, Ptr buf, UInt32 bufSize)
  551. // ---------------------------------------------------------------------------
  552. {
  553.     Ptr        end = buf + bufSize;
  554.     Byte    len = string[0] + 1;
  555.     short    index;
  556.     
  557.     while((buf < end) && (*buf++ != string[0])) ;    // scan for the proper length
  558.  
  559.     if(!(buf < end)){
  560.         return false;
  561.     }
  562.     for(index = 1; (index < len) && (buf > end); index++){
  563.         if(*buf++ != string[index])
  564.             return false; 
  565.     }
  566.     if(!(buf < end)){
  567.         return false;
  568.     }
  569.     return true;
  570. }
  571.  
  572.  
  573.  
  574.  
  575.  
  576.